home *** CD-ROM | disk | FTP | other *** search
/ Aminet 7 / Aminet 7 - August 1995.iso / Aminet / comm / tcp / GetMail3.lha / GetMail.doc < prev    next >
Text File  |  1995-06-03  |  7KB  |  194 lines
  1.  
  2. GetMail - Version 1.10
  3.  
  4.  
  5. INTRODUCTION:
  6.  
  7. GetMail is a POP Client, it is used for receiving mail to your
  8. local Amiga host from an Internet POP host.
  9.  
  10. GetMail was written with referance to the following mail RFC's.
  11. RFC-821, RFC-822, RFC-1081, RFC-1225, RFC-1725.
  12.  
  13.  
  14. REQUIREMENTS:
  15.  
  16. Getmail requires WB 2.04 as a minimum (and will also utilise the
  17. file buffering of WB 3.0 where possible).
  18.  
  19. GetMail is for use with AmiTCP (it will not work with AS225), it
  20. was developed on version 4.0 of AmiTCP but I have linked the 
  21. program to the old version 3 Net.lib for AmiTCP 3.0 Beta users.
  22. A number of MLink users are also using GetMail successfully.
  23.  
  24.  
  25. BACKGROUND:
  26.  
  27. When I signed up to get Internet access I keenly downloaded software
  28. from my local BBS and was immediately disapointed while reading the
  29. installation instructions.  It was quite clear that much of the
  30. software was ported from the Unix/UUCP environment as the software
  31. wanted a lot of assigns like UULib:, UUSpool: and many environmental
  32. variables.  Even worse, several software packages used the 
  33. environmental variables in conflicting mannors.  The Ported Unix
  34. code did not take full advantage to the Amiga OS and resulted in 
  35. large executable sizes.  I decided to write my own utilities.
  36.  
  37.  
  38. INSTALLATION:
  39.  
  40. I have provided both 68000 and 68020 executables for both AmiTCP
  41. version 4 and AmiTCP version 3.
  42.  
  43. Simply copy the GetMail executable (this is a dos command so no icon is
  44. required) to a location somewhere in your path.  A good place for it is
  45. in the AmiTCP:bin drawer.
  46.  
  47. I reccommend creating a file in your home directory named '.EMailAddr'
  48. (without the 's) which should hold your full E-Mail address (which is
  49. also used by PutMail).  See the details of EMAILADDR below.
  50.  
  51. Next we need a POPHost definition which is the name of the POP Host
  52. that holds your E-Mail mailbox.  AmiTCP users should put an entry
  53. in their AmiTCP:db/hosts file, MLink users should create an
  54. environmental variable.  See the details of POPHOST below.
  55.  
  56. These items are not manditory but they do reduce the arguments that
  57. you need to pass to GetMail.
  58.  
  59. Provided AmiTCP is up and running you can use GetMail immediately.
  60.  
  61.          
  62. OVERVIEW:
  63.  
  64. GetMail receives mail to the local AmiTCP user's HOME directory.
  65. The local file is "From " delimited (same as AmiPOP).
  66.  
  67. GetMail uses three environmental variables that all exist in AmiTCP
  68. installations.  They are USER (userid), HOME (home drawer) and
  69. HOSTNAME (localhostname.domain).  Home can however be specified on
  70. the command line (useful for multiple AmiTCP users on same machine).
  71.  
  72. Please note that AmiTCP creates the above three environmntal variables
  73. for you.  AmiTCP users should not have to setup these variables manually.
  74.  
  75.  
  76. USAGE:
  77.  
  78. The command template for GetMail is "GetMail MAIL=MAILFILE/K,
  79. USER/K,PASS=PASSWORD/A,HOME/K,EMAILADDR/K,POPHOST/K,DELETE/S,VERBOSE/S".
  80.  
  81.  
  82. Lets go through the arguments one by one.
  83.  
  84.  
  85. MAIL=MAILFILE     Optional argument.
  86.  
  87. This is the name of your local mail message file in your home directory
  88. directory where messages are to be stored.  It must be file name with no
  89. device name as GetMail appends this name to your home path.  If the mail
  90. file does not exist it will be created.  If it does exist the mail will
  91. be appended to it.  The default name is "MailBox.InWard".  The argument
  92. can be specified as MAILFILE=foo or abreviated as MAIL=foo.
  93.  
  94.  
  95. USER              Optional argument.
  96.  
  97. This is the LogonID you use to access the POP Host.  If you don't
  98. provide this argument your local AmiTCP UserID will be used.
  99. This required because sometimes your LogonID is not the same as your
  100. mailbox UserID.  If you specify another valid AmiTCP user then
  101. the HOME directory for that user will be obtained from the password
  102. file.  This will over ride the HOME argument and the HOME environmental
  103. variable.  This does not happen when using MLink.
  104.  
  105.  
  106. PASS=PASSWORD     Manditory argument.
  107.  
  108. This is the password you use to access the POP Host.
  109.  
  110.  
  111. HOME              Optional argument.
  112.  
  113. This is your home path where your mailbox, E-Mail Header, E-Mail Signature
  114. and E-Mail Address is stored.  Most people will probally not use this.
  115. If HOME is not specified then the environmental variable HOME will be used.
  116. If you use the USER argument for another AmiTCP user then the home path is
  117. obtained from the password file (none functional on MLink).
  118.  
  119.  
  120. EMAIL=EMAILADDR   Optional argument.
  121.  
  122. This is your full E-Mail address.  If this argument is not supplied
  123. GetMail will use the environmental variable EMAILADDR, if that doesn't
  124. exist it will read the HOME:.EMailAddr file, if that does not exist it
  125. will use your local AmiTCP UserID and the name of the POPHost that you
  126. are connecting to.
  127.  
  128. The contents of the HOME:.EMailAddr file can be in one of three formats.
  129.  
  130. 1) user@domain          eg: mlanza@southern.co.nz
  131. 2) user@domain (Name)   eg: mlanza@southern.co.nz (Martin V Lanza)
  132. 3) Name <user@domain>   eg: Martin V Lanza <mlanza@southern.co.nz>
  133.  
  134.  
  135. POPHOST           Optional argument.
  136.  
  137. This is the name of the POP host that holds your E-Mail mailbox.
  138. If this argument is not supplied GetMail will use the environmental
  139. variable POPHOST, if that doesn't exist it will look in your local
  140. AmiTCP:db/hosts file for an alias of POPHost, if that does not exist
  141. GetMail will use the name of the host that you are connected to
  142. (obtained from the domain part of the local host name in the
  143. environmental variable HOSTNAME).
  144.  
  145. Example of the hosts file entry.
  146. 192.231.84.33 mail.southern.co.nz POPHost
  147.  
  148.  
  149. DELETE            Optional argument.
  150.  
  151. This argument switches on deletion of messages read from the mailbox.
  152.  
  153.  
  154. VERBOSE           Optional argument.
  155.  
  156. This argument simply switches on verbose reporting of the program's
  157. activities and progress.  If you have problems using GetMail this may
  158. help explain why it's not working.  You can always redirect the verbose
  159. output to a file and post this to be if you need assistance.
  160.  
  161.  
  162. DEVELOPMENT:
  163.  
  164. GetMail was developed on an Amiga 3000 running WB 3.1 using SAS/C 6.55.
  165.  
  166.  
  167. SO LONG AND THANKS FOR THE FISH:
  168.  
  169. I hope you find GetMail easy to use and usefull.
  170.  
  171. Bug reports, Comments, ideas, *POSTCARDS*, E-Mail, gifts and requests
  172. for new utilities all welcome.
  173.  
  174. -------------------------------------------------------------------------
  175.  
  176. This program is freeware, use and/or distribute as you wish
  177. on a "NON Profit" basis.  Inclusion on the Aminet and Fred Fish
  178. CD's is welcomed due to their long standing support of the Amiga.
  179.  
  180. No warranty exists, use this software at your own risk.
  181. I will answer all E-Mail and Snail-Mail messages.
  182. I can also be contacted on IRC #Amiga as mlanza.
  183. I do provide bug fixes via UUEncoded E-Mail.
  184.  
  185. Martin V Lanza
  186. PO Box 8344,
  187. Christchurch,
  188. New Zealand.
  189.  
  190. mlanza@southern.co.nz
  191.  
  192. Home Phone 64-3-366-1618
  193.  
  194.